// Copyright (C) 2002-2015 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __C_GUI_EDIT_BOX_H_INCLUDED__
#define __C_GUI_EDIT_BOX_H_INCLUDED__

#include "IrrCompileConfig.h"
#include "IGUIEditBox.h"
#include "irrArray.h"
#include "IOSOperator.h"
#include "../../utils/leak_check.h"

#include "../../utils/time.h"

using namespace irr;
using namespace gui;

    class CGUIEditBox : public IGUIEditBox
    {
    public:

        LEAK_CHECK()

        //! constructor
        CGUIEditBox(const wchar_t* text, bool border, IGUIEnvironment* environment,
            IGUIElement* parent, s32 id, const core::rect<s32>& rectangle, bool is_rtl);

        //! destructor
        virtual ~CGUIEditBox();

        //! Sets another skin independent font.
        virtual void setOverrideFont(IGUIFont* font=0);

        //! Sets another color for the text.
        virtual void setOverrideColor(video::SColor color);

        //! Gets the override color
        virtual video::SColor getOverrideColor() const;

        //! Sets if the text should use the overide color or the
        //! color in the gui skin.
        virtual void enableOverrideColor(bool enable);

        //! Checks if an override color is enabled
        /** \return true if the override color is enabled, false otherwise */
        virtual bool isOverrideColorEnabled(void) const;

        //! Turns the border on or off
        virtual void setDrawBorder(bool border);

        //! Enables or disables word wrap for using the edit box as multiline text editor.
        virtual void setWordWrap(bool enable);

        //! Checks if word wrap is enabled
        //! \return true if word wrap is enabled, false otherwise
        virtual bool isWordWrapEnabled() const;

        //! Enables or disables newlines.
        /** \param enable: If set to true, the EGET_EDITBOX_ENTER event will not be fired,
        instead a newline character will be inserted. */
        virtual void setMultiLine(bool enable);

        //! Checks if multi line editing is enabled
        //! \return true if mult-line is enabled, false otherwise
        virtual bool isMultiLineEnabled() const;

        //! Enables or disables automatic scrolling with cursor position
        //! \param enable: If set to true, the text will move around with the cursor position
        virtual void setAutoScroll(bool enable);

        //! Checks to see if automatic scrolling is enabled
        //! \return true if automatic scrolling is enabled, false if not
        virtual bool isAutoScrollEnabled() const;

        //! Gets the size area of the text in the edit box
        //! \return Returns the size in pixels of the text
        virtual core::dimension2du getTextDimension();

        //! Sets text justification
        virtual void setTextAlignment(EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical);

        //! called if an event happened.
        virtual bool OnEvent(const SEvent& event);

        //! draws the element and its children
        virtual void draw();

        //! Sets the new caption of this element.
        virtual void setText(const wchar_t* text);

        //! Sets the maximum amount of characters which may be entered in the box.
        //! \param max: Maximum amount of characters. If 0, the character amount is
        //! infinity.
        virtual void setMax(u32 max);

        //! Returns maximum amount of characters, previously set by setMax();
        virtual u32 getMax() const;

        //! Sets whether the edit box is a password box. Setting this to true will
        /** disable MultiLine, WordWrap and the ability to copy with ctrl+c or ctrl+x
        \param passwordBox: true to enable password, false to disable
        \param passwordChar: the character that is displayed instead of letters */
        virtual void setPasswordBox(bool passwordBox, wchar_t passwordChar = L'*');

        //! Returns true if the edit box is currently a password box.
        virtual bool isPasswordBox() const;

        //! Updates the absolute position, splits text if required
        virtual void updateAbsolutePosition();

        //! Writes attributes of the element.
        virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options) const;

        //! Reads attributes of the element
        virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options);

        virtual irr::gui::IGUIFont* getOverrideFont() const { return NULL; }
        virtual irr::gui::IGUIFont* getActiveFont() const { return NULL; }
        virtual void setDrawBackground(bool) { }

    protected:
        //! Breaks the single text line.
        void breakText();
        //! sets the area of the given line
        void setTextRect(s32 line);
        //! returns the line number that the cursor is on
        s32 getLineFromPos(s32 pos);
        //! adds a letter to the edit box
        void inputChar(wchar_t c);
        //! calculates the current scroll position
        void calculateScrollPos();
        //! send some gui event to parent
        void sendGuiEvent(EGUI_EVENT_TYPE type);
        //! set text markers
        void setTextMarkers(s32 begin, s32 end);

        bool processKey(const SEvent& event);
        bool processMouse(const SEvent& event);
        s32 getCursorPos(s32 x, s32 y);

        bool MouseMarking;
        bool Border;
        bool OverrideColorEnabled;
        s32 MarkBegin;
        s32 MarkEnd;

        video::SColor OverrideColor;
        gui::IGUIFont *OverrideFont, *LastBreakFont;
        IOSOperator* Operator;

        StkTime::TimeType BlinkStartTime;
        s32 CursorPos;
        s32 HScrollPos, VScrollPos; // scroll position in characters
        u32 Max;

        bool m_rtl;

        bool WordWrap, MultiLine, AutoScroll, PasswordBox;
        wchar_t PasswordChar;
        EGUI_ALIGNMENT HAlign, VAlign;

        core::array< core::stringw > BrokenText;
        core::array< s32 > BrokenTextPositions;

        core::rect<s32> CurrentTextRect, FrameRect; // temporary values
    };



#endif // __C_GUI_EDIT_BOX_H_INCLUDED__

